/*
** $Id: lstring.c $
** String table (keeps all strings handled by Lua)
** See Copyright Notice in lua.h
*/

#define lstring_c
#define LUA_CORE

#include "lprefix.h"


#include <string.h>

#include "lua.h"

#include "ldebug.h"
#include "ldo.h"
#include "lmem.h"
#include "lobject.h"
#include "lstate.h"
#include "lstring.h"


/*
** stringtable的最大大小
*/
#define MAXSTRTB	cast_int(luaM_limitN(MAX_INT, TString*))


/*
** 长字符串的等式
*/
int luaS_eqlngstr (TString *a, TString *b) {
  size_t len = a->u.lnglen;
  lua_assert(a->tt == LUA_VLNGSTR && b->tt == LUA_VLNGSTR);
  return (a == b) ||  /* 同一实例 or... */
    ((len == b->u.lnglen) &&  /* 长度相等并且 ... */
     (memcmp(getstr(a), getstr(b), len) == 0));  /* 内容一样 */
}

// string的hash
unsigned int luaS_hash (const char *str, size_t l, unsigned int seed) {
  unsigned int h = seed ^ cast_uint(l);
  for (; l > 0; l--)
    h ^= ((h<<5) + (h>>2) + cast_byte(str[l - 1]));
  return h;
}

// 长字符串的hash
unsigned int luaS_hashlongstr (TString *ts) {
  lua_assert(ts->tt == LUA_VLNGSTR);
  if (ts->extra == 0) {  /* no hash? */
    size_t len = ts->u.lnglen;
    ts->hash = luaS_hash(getstr(ts), len, ts->hash);
    ts->extra = 1;  /* 标记现在有hash值了 */
  }
  return ts->hash;
}

// 重新计算stringtable的hash
static void tablerehash (TString **vect, int osize, int nsize) {
  int i;
  for (i = osize; i < nsize; i++)  /* 清空新元素 */
    vect[i] = NULL;
  for (i = 0; i < osize; i++) {  /* 对数组中的老数据重新计算hash */
    TString *p = vect[i];
    vect[i] = NULL;
    while (p) {  /* 遍历这个链表中的所有字符串 */
      TString *hnext = p->u.hnext;  /* 保存下一个 */
      unsigned int h = lmod(p->hash, nsize);  /* 新位置 */
      p->u.hnext = vect[h];  /* 链接到数组 */
      vect[h] = p;
      p = hnext;
    }
  }
}


/*
** 调整stringtable的大小，如果分配失败，保持当前长度
** (这可能会降低性能，但任何非零大小都应该可以正常工作)
*/
void luaS_resize (lua_State *L, int nsize) {
  stringtable *tb = &G(L)->strt;
  int osize = tb->size;
  TString **newvect;
  if (nsize < osize)  /* 缩小table? */
    tablerehash(tb->hash, osize, nsize);  /* 直接清空多的 */
  newvect = luaM_reallocvector(L, tb->hash, osize, nsize, TString*);
  if (l_unlikely(newvect == NULL)) {  /* 重新分配失败? */
    if (nsize < osize)  /* 是否缩小table? */
      tablerehash(tb->hash, nsize, osize);  /* 重新设置为原来的大小 */
  }
  else {  /* 分配成功 */
    tb->hash = newvect;
    tb->size = nsize;
    if (nsize > osize)
      tablerehash(newvect, osize, nsize);
  }
}


/*
** 清除API字符串缓存。(条目不能为空，所以用不可收集的字符串填充它们。)
*/
void luaS_clearcache (global_State *g) {
  int i, j;
  for (i = 0; i < STRCACHE_N; i++)
    for (j = 0; j < STRCACHE_M; j++) {
      if (iswhite(g->strcache[i][j]))  /* 将被收集? */
        g->strcache[i][j] = g->memerrmsg;  /* 用固定值来替换 */
    }
}


/*
** 初始化字符串表和字符串缓存
*/
void luaS_init (lua_State *L) {
  global_State *g = G(L);
  int i, j;
  stringtable *tb = &G(L)->strt;
  tb->hash = luaM_newvector(L, MINSTRTABSIZE, TString*);
  tablerehash(tb->hash, 0, MINSTRTABSIZE);  /* 清空数组 */
  tb->size = MINSTRTABSIZE;
  /* 预先创建内存分配错误信息字面量 */
  g->memerrmsg = luaS_newliteral(L, MEMERRMSG);
  luaC_fix(L, obj2gco(g->memerrmsg));  /* 永远不会被收集 */
  for (i = 0; i < STRCACHE_N; i++)  /* 使用有效字符串填充缓存 */
    for (j = 0; j < STRCACHE_M; j++)
      g->strcache[i][j] = g->memerrmsg;
}



/*
** 创建新的string对象
*/
static TString *createstrobj (lua_State *L, size_t l, int tag, unsigned int h) {
  TString *ts;
  GCObject *o;
  size_t totalsize;  /* TString对象的总内存大小 */
  totalsize = sizelstring(l);
  o = luaC_newobj(L, tag, totalsize);
  ts = gco2ts(o);
  ts->hash = h;
  ts->extra = 0;
  getstr(ts)[l] = '\0';  /* 末尾 0 */
  return ts;
}

// 创建长字符串对象
TString *luaS_createlngstrobj (lua_State *L, size_t l) {
  TString *ts = createstrobj(L, l, LUA_VLNGSTR, G(L)->seed);
  ts->u.lnglen = l;
  return ts;
}


// 从stringtable中移除TString
void luaS_remove (lua_State *L, TString *ts) {
  stringtable *tb = &G(L)->strt;
  TString **p = &tb->hash[lmod(ts->hash, tb->size)];
  while (*p != ts)  /* 查找前一个元素 */
    p = &(*p)->u.hnext;
  *p = (*p)->u.hnext;  /* 将元素从他的列表中删除 */
  tb->nuse--;
}


static void growstrtab (lua_State *L, stringtable *tb) {
  if (l_unlikely(tb->nuse == MAX_INT)) {  /* 太多字符串了? */
    luaC_fullgc(L, 1);  /* 尝试释放一些字符串... */
    if (tb->nuse == MAX_INT)  /* 仍然太大了? */
      luaM_error(L);  /* 甚至不能创建一个消息 */
  }
  if (tb->size <= MAXSTRTB / 2)  /* 能扩展string table? */
    luaS_resize(L, tb->size * 2);
}


/*
** 检测一个字符串是否已经存在，如果存在则复用，否则创建一个新的
*/
static TString *internshrstr (lua_State *L, const char *str, size_t l) {
  TString *ts;
  global_State *g = G(L);
  stringtable *tb = &g->strt;
  unsigned int h = luaS_hash(str, l, g->seed);
  TString **list = &tb->hash[lmod(h, tb->size)];
  lua_assert(str != NULL);  /*  否则'memcmp'/'memcpy'是未定义的 */
  for (ts = *list; ts != NULL; ts = ts->u.hnext) {
    if (l == ts->shrlen && (memcmp(str, getstr(ts), l * sizeof(char)) == 0)) {
      /* 找到了! */
      if (isdead(g, ts))  /* 死亡 (但还没有被收集)? */
        changewhite(ts);  /* 复活它 */
      return ts;
    }
  }
  /* 没有找到则创建一个新的字符串 */
  if (tb->nuse >= tb->size) {  /* 需要扩充字符串表? */
    growstrtab(L, tb);
    list = &tb->hash[lmod(h, tb->size)];  /* 使用新尺寸进行rehash */
  }
  ts = createstrobj(L, l, LUA_VSHRSTR, h);
  memcpy(getstr(ts), str, l * sizeof(char));
  ts->shrlen = cast_byte(l);
  ts->u.hnext = *list;
  *list = ts;
  tb->nuse++;
  return ts;
}


/*
** 创建一个新字符串(通过具体长度)
*/
TString *luaS_newlstr (lua_State *L, const char *str, size_t l) {
  if (l <= LUAI_MAXSHORTLEN)  /* 短字符串 */
    return internshrstr(L, str, l);
  else {
    TString *ts;
    if (l_unlikely(l >= (MAX_SIZE - sizeof(TString))/sizeof(char)))
      luaM_toobig(L);
    ts = luaS_createlngstrobj(L, l);
    memcpy(getstr(ts), str, l * sizeof(char));
    return ts;
  }
}


/*
** 创建或复用一个以‘\0’结尾的字符串(0结尾字符串)
** 首先检查缓存 (使用字符串地址做为key)。 缓存包含一个 0结尾字符串,所以使用'strcmp'检查命中是安全的。
*/
TString *luaS_new (lua_State *L, const char *str) {
  unsigned int i = point2uint(str) % STRCACHE_N;  /* hash */
  int j;
  TString **p = G(L)->strcache[i];
  for (j = 0; j < STRCACHE_M; j++) {
    if (strcmp(str, getstr(p[j])) == 0)  /* hit? */
      return p[j];  /* that is it */
  }
  /* normal route */
  for (j = STRCACHE_M - 1; j > 0; j--)
    p[j] = p[j - 1];  /* 将最后一个对应hash的字符串移除出去 */
  /* 在list中创建一个新的字符串放入list的0号位 */
  p[0] = luaS_newlstr(L, str, strlen(str));
  return p[0];
}


Udata *luaS_newudata (lua_State *L, size_t s, int nuvalue) {
  Udata *u;
  int i;
  GCObject *o;
  if (l_unlikely(s > MAX_SIZE - udatamemoffset(nuvalue)))
    luaM_toobig(L);
  o = luaC_newobj(L, LUA_VUSERDATA, sizeudata(nuvalue, s));
  u = gco2u(o);
  u->len = s;
  u->nuvalue = nuvalue;
  u->metatable = NULL;
  for (i = 0; i < nuvalue; i++)
    setnilvalue(&u->uv[i].uv);
  return u;
}

